home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / catn / frame.n < prev    next >
Text File  |  1994-09-20  |  6KB  |  199 lines
  1.  
  2.  
  3.  
  4. frame(n)                   Tk Commands
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      frame - Create and manipulate frame widgets
  12.  
  13. SYNOPSIS
  14.      frame _p_a_t_h_N_a_m_e ?-class _c_l_a_s_s_N_a_m_e? ?_o_p_t_i_o_n_s?
  15.  
  16. STANDARD OPTIONS
  17.      background      cursor         relief                         |
  18.      borderWidth     geometry
  19.  
  20.      See the ``options'' manual entry for details on the standard
  21.      options.
  22.  
  23. WIDGET-SPECIFIC OPTIONS
  24.      Name:           height                                        |
  25.      Class:          Height                                        |
  26.      Command-Line Switch:           -height                        |
  27.  
  28.                                                                         ||
  29.           Specifies  the  desired height for the window in any of  |
  30.           the forms acceptable to Tk_GetPixels.  This  option  is  |
  31.           only  used  if the -geometry option is unspecified.  If  |
  32.           this  option  is  less  than  or  equal  to  zero  (and  |
  33.           -geometry  is  not  specified) then the window will not  |
  34.           request any size at all.                                 |
  35.  
  36.      Name:           width                                         |
  37.      Class:          Width                                         |
  38.      Command-Line Switch:           -width                         |
  39.  
  40.                                                                         ||
  41.           Specifies  the  desired  width for the window in any of  |
  42.           the forms acceptable to Tk_GetPixels.  This  option  is  |
  43.           only  used  if the -geometry option is unspecified.  If  |
  44.           this  option  is  less  than  or  equal  to  zero  (and  |
  45.           -geometry  is  not  specified) then the window will not  |
  46.           request any size at all.
  47. _________________________________________________________________
  48.  
  49.  
  50. DESCRIPTION
  51.      The frame command creates a new window (given by  the  _p_a_t_h_-
  52.      _N_a_m_e argument) and makes it into a frame widget.  Additional
  53.      options, described above, may be specified  on  the  command
  54.      line  or  in the option database to configure aspects of the
  55.      frame such as its background color and  relief.   The  frame
  56.      command returns the path name of the new window.
  57.  
  58.      A frame is a simple widget.  Its primary purpose is  to  act
  59.      as  a  spacer  or container for complex window layouts.  The
  60.  
  61.  
  62.  
  63. Tk                                                              1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. frame(n)                   Tk Commands
  71.  
  72.  
  73.  
  74.      only features of a frame are its  background  color  and  an
  75.      optional  3-D  border  to  make  the  frame appear raised or
  76.      sunken.
  77.  
  78.      In addition to the standard options listed above,  a  -class
  79.      option  may  be  specified  on  the  command line.  If it is
  80.      specified, then the  new  widget's  class  will  be  set  to
  81.      _c_l_a_s_s_N_a_m_e  instead  of Frame.  Changing the class of a frame
  82.      widget may be useful in order to use a special class name in
  83.      database  options referring to this widget and its children.
  84.      Note:  -class is handled differently than other command-line
  85.      options  and  cannot  be specified using the option database
  86.      (it has to be processed before the other  options  are  even
  87.      looked  up,  since the new class name will affect the lookup
  88.      of the other options).  In addition, the -class  option  may
  89.      not be queried or changed using the config command described
  90.      below.
  91.  
  92.  
  93. WIDGET COMMAND
  94.      The frame command creates a new Tcl command  whose  name  is
  95.      the  same as the path name of the frame's window.  This com-
  96.      mand may be used to invoke various operations on the widget.
  97.      It has the following general form:
  98.  
  99.           _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
  100.  
  101.      _P_a_t_h_N_a_m_e is the name of the command, which is  the  same  as
  102.      the frame widget's path name.  _O_p_t_i_o_n and the _a_r_gs determine
  103.      the exact behavior of the command.  The  following  commands
  104.      are possible for frame widgets:
  105.  
  106.      _p_a_t_h_N_a_m_e configure ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...?
  107.           Query  or  modify  the  configuration  options  of  the
  108.           widget.   If  no  _o_p_t_i_o_n  is  specified, returns a list
  109.           describing all of the available  options  for  _p_a_t_h_N_a_m_e
  110.           (see  Tk_ConfigureInfo for information on the format of
  111.           this list).  If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then
  112.           the  command  returns  a  list describing the one named
  113.           option (this list will be identical to the  correspond-
  114.           ing  sublist  of  the  value  returned  if no _o_p_t_i_o_n is
  115.           specified).  If one  or  more  _o_p_t_i_o_n-_v_a_l_u_e  pairs  are
  116.           specified,  then  the command modifies the given widget
  117.           option(s) to have the given value(s);  in this case the
  118.           command  returns  an empty string.  _O_p_t_i_o_n may have any
  119.           of the values accepted by the frame command.
  120.  
  121.  
  122. BINDINGS
  123.      When a new frame is created, it has no default  event  bind-
  124.      ings: frames are not intended to be interactive.
  125.  
  126.  
  127.  
  128.  
  129. Tk                                                              2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. frame(n)                   Tk Commands
  137.  
  138.  
  139.  
  140. KEYWORDS
  141.      frame, widget
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195. Tk                                                              3
  196.  
  197.  
  198.  
  199.